home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 049a / qwk_txt1.zip / QWK-TXT.TXT < prev    next >
Text File  |  1991-07-22  |  11KB  |  239 lines
  1.  
  2.  
  3.  
  4.  
  5.                     ╔═══════════════════════════════════════╗ 
  6.                     ║                                       ║ 
  7.                     ║                QWK-TXT                ║ 
  8.                     ║               ~~~~~~~~~               ║ 
  9.                     ║              Version 1.0              ║ 
  10.                     ║                                       ║ 
  11.                     ║    An ASCII translation utility for   ║
  12.                     ║      '.QWK' compatible mail files.    ║
  13.                     ║                                       ║ 
  14.                     ╚═══════════════════════════════════════╝ 
  15.                       Copyright (c) 1991 - Richard D. Howard
  16.                              17522 Vandenberg Lane #6 
  17.                              Tustin, California 92680 
  18.                                voice (714) 544-0772 
  19.  
  20.  
  21.  
  22.  
  23.                                 License Agreement 
  24.                                ~~~~~~~~~~~~~~~~~~~ 
  25.  
  26.         This program is being distributed as 'Freeware'.      You are 
  27.         encouraged to freely distribute the QWK-TXT product under the 
  28.         conditions that no changes are made to the program, data, or 
  29.         documentation, and provided that no fees are charged. 
  30.  
  31.         The QWK-TXT software, manual, and associated files are protected 
  32.         by United States copyright law and international treaties, and 
  33.         under no condition should any portion be considered in the public 
  34.         domain. 
  35.  
  36.         The author makes no claims as to the suitability of QWK-TXT for 
  37.         any particular purpose, and assumes no liability for any damages 
  38.         arising from the deficiencies, use or misuse of the program. 
  39.  
  40.  
  41.  
  42.  
  43.  
  44.                               Trademarks Mentioned
  45.                              ~~~~~~~~~~~~~~~~~~~~~~
  46.  
  47.         IBM is a trademark of International Business Machines, Inc.    
  48.  
  49.         MS-DOS is a trademark of Microsoft Corporation.    
  50.         
  51.         Turbo Pascal, Turbo C, Turbo Assembler, Turbo Debugger, and BGI 
  52.         are all trademarks of Borland International.    
  53.         
  54.         All other trademarks and registered names are the property of 
  55.         their respective owners. 
  56.  
  57.  
  58.     ──────────────────────────────────────────────────────────────────────── 
  59.     7/15/91                       QWK-TXT v1.0                        Page 1 
  60.  
  61.  
  62.  
  63.  
  64.                                 Program Overview 
  65.                                ~~~~~~~~~~~~~~~~~~
  66.  
  67.         QWK-TXT is a translation utility designed to read '.QWK' formatted 
  68.         mail into a simple ASCII format.      The resulting ASCII file may 
  69.         then be easily viewed with one of the many popular ASCII viewing 
  70.         utilities such as Vernon Buerg's 'LIST.COM ', or a hard-copy 
  71.         printout created with any device supporting the full set of IBM 
  72.         graphic characters. 
  73.  
  74.         QWK-TXT writes the '.QWK' format data with all the message header 
  75.         information fully expanded,   and integrates the BBS name and 
  76.         phone number as supplied in the packet control file by each BBS.       
  77.         The program performs NO extraneous message formatting beyond 
  78.         stripping the '.QWK' added white space at the end of each message, 
  79.         and places NO limitations on the length or width of the messages. 
  80.  
  81.         I have attempted to simplify browsing of messages by surrounding 
  82.         the body of each message with double linedraw characters in the 
  83.         top, left, and bottom margins.       This combined with the boxing 
  84.         of the message headers allows for easier visual identification of 
  85.         specific elements, particularly when quickly scanning message 
  86.         posts.   (At least for me...) 
  87.  
  88.         Provisions have been made for post-translation browsing using any 
  89.         of the windowing ASCII viewers incorporating on-screen frames and 
  90.         scroll bars by holding the right margin of headers to 78 columns.      
  91.         This allows ALL of the normal message information to be displayed 
  92.         on one standard 80 column screen without requiring horizontal 
  93.         scrolling. 
  94.  
  95.         This was my first (educational) foray into the land of '.QWK', and 
  96.         though QWK-TXT is currently quite modest, I believe you'll find it 
  97.         useful.     Future plans include the addition of optional message 
  98.         sorting, filtering based on conference or included strings, and 
  99.         possibly user customizable header styles.      Input is welcome. 
  100.         
  101.  
  102.  
  103.  
  104.                                     Limitations 
  105.                                    ~~~~~~~~~~~~~
  106.  
  107.         QWK-TXT has been in daily use as my primary '.QWK' archive method 
  108.         for about six months, and has proven quite stable.      If you do 
  109.         find some bug, please contact me and I'll attempt to squash it. 
  110.         
  111.         QWK-TXT has a known theoretical limit on the number of concurrent 
  112.         conferences.      If anyone knows of a single BBS having over 3364 
  113.         conferences, first encourage the SYSOP to seek psychiatric help and 
  114.         then contact me about possible modifications. 
  115.  
  116.  
  117.     ──────────────────────────────────────────────────────────────────────── 
  118.     7/15/91                       QWK-TXT v1.0                        Page 2 
  119.  
  120.  
  121.  
  122.  
  123.                                   Installation
  124.                                  ~~~~~~~~~~~~~~
  125.  
  126.         The QWT-TXT archive should contain the following files:
  127.  
  128.               QWK-TXT.EXE........Program executable.
  129.               QWK-TXT.TXT........Program documentation.
  130.      
  131.  
  132.  
  133.         To install QWK-TXT, copy the ENTIRE contents of the archive to the 
  134.         main directory of your offline mail reader.      Insert a call to 
  135.         QWK-TXT in the section of your reader configuration that allows 
  136.         external commands to be run from within the reader.       External 
  137.         programs are generally accessed with an assigned "hot key", such 
  138.         as a shifted function key.     Choose the key combination that is 
  139.         most convenient for you.
  140.  
  141.         Several offline mail readers offer the option of swapping part of 
  142.         their program code to extended memory, expanded memory, or disk 
  143.         when calling external programs.       The use of such an option 
  144.         with QWK-TXT is unnecessary, and may in fact introduce a noticable 
  145.         delay in accessing the program.      If you wish to use this type 
  146.         of feature, consult the offline reader documentation.
  147.  
  148.         Keep in mind that most mail readers make a working copy of the 
  149.         mail packets as they read them.      This copy is generally placed 
  150.         in a subdirectory beneath the main mail reader directory.     If 
  151.         this is the case with your offline reader, you can specify that 
  152.         the QWK-TXT program is to be executed from the parent directory by 
  153.         prefixing the program name with "..\" in the command line call. 
  154.         
  155.         For instance, the command line:
  156.  
  157.                 ..\QWK-TXT 
  158.  
  159.         would execute the QWK-TXT program from the parent of the current 
  160.         directory using the default files. 
  161.  
  162.  
  163.  
  164.  
  165.         QWK-TXT is primarily designed to be used from a shell within one 
  166.         of the many popular offline '.QWK' mail readers.     As such, it 
  167.         expects all the '.QWK' data files to be readily accessable.    If 
  168.         you wish to use this utility outside of a mail reader, it's up to 
  169.         YOU to make the data files available by unarchiving the  '.QWK' 
  170.         mail packet before use. 
  171.  
  172.  
  173.  
  174.  
  175.  
  176.     ──────────────────────────────────────────────────────────────────────── 
  177.     7/15/91                       QWK-TXT v1.0                        Page 3 
  178.  
  179.  
  180.  
  181.  
  182.                                   Program Usage
  183.                                  ~~~~~~~~~~~~~~~
  184.     
  185.         QWK-TXT [/H] [<outfile>] [<infile>] [<bbsfile>] 
  186.  
  187.            /H is an optional switch displaying a help screen.
  188.                                                                 
  189.            <outfile> is an optional parameter specifying the
  190.            fully qualified name of the output file.    QWK-TXT
  191.            appends the message text to this file.     If none
  192.            is specified 'MESSAGES.TXT' will be used, and
  193.            automatically overwritten.
  194.  
  195.            <infile> is an optional parameter specifying the
  196.            fully qualified name of the input file.    If none
  197.            is specified 'MESSAGES.DAT' is used.
  198.  
  199.            <bbsfile> is an optional parameter specifying the
  200.            fully qualified name of the bbs packet control
  201.            file.     If none is specified 'CONTROL.DAT' is used.
  202.  
  203.         QWK-TXT may be run at any time after selecting a mail packet
  204.         in your reader.       Simply hit the previously defined key
  205.         and the current packet will be translated to ASCII.
  206.  
  207.         QWK-TXT runs "silently", displaying only a copyright notice and 
  208.         noting any abnormal conditions on the console.       If you wish, 
  209.         the program may be truly silenced by redirecting even this meager 
  210.         output to the DOS 'NUL' device, thusly: 
  211.  
  212.                 QWK-TXT <outfile> <infile> <control> > nul
  213.  
  214.  
  215.                                     Errors
  216.                                    ~~~~~~~~
  217.  
  218.         If QWK-TXT encounters any serious errors, it attempts to exit 
  219.         gracefully and sets the DOS 'ERRORLEVEL' variable to one of the 
  220.         following codes: 
  221.  
  222.                       ╔═══════╤══════════════════════════╗
  223.                       ║  Code │  Meaning                 ║
  224.                       ╟───────┼──────────────────────────╢
  225.                       ║   0   │  Normal exit             ║
  226.                       ╟───────┼──────────────────────────╢
  227.                       ║   1   │  File does not exist     ║
  228.                       ╟───────┼──────────────────────────╢
  229.                       ║   2   │  Error opening file      ║
  230.                       ╟───────┼──────────────────────────╢
  231.                       ║   3   │  Error writing file      ║
  232.                       ╟───────┼──────────────────────────╢
  233.                       ║   4   │  Out of memory           ║
  234.                       ╚═══════╧══════════════════════════╝
  235.     ──────────────────────────────────────────────────────────────────────── 
  236.     7/15/91                       QWK-TXT v1.0                        Page 4 
  237.  
  238.  
  239.